************************************************************************
Copyright (c) 1999 - 2005 redcoal Pty. Ltd.
************************************************************************

This file contains the following information:

1. Sample inclusion.
2. How to build the sample project.
3. How to run the sample program.
   3.1 How to send text SMS
   3.2 How to send binary SMS
   3.3 How to send MMS
   3.4 How to send WAP service indication
   3.5 How to receive SMS reply
   3.6 How to check message status

************************************************************************

1. Sample inclusion.

The Borland C++ Builder 6.0 sample project has the following files:

- Readme.txt: this file.
- SoapClient.bpr: this is the main project file.
- SoapClient.cpp: this is the windows main routine
                  which is automatically generated.
- SoapClient.res: this is the resource file
                  which is automatically generated.
- SoapClient.exe: this is the final executable file.
- MainFrm.dfm: this is the main form layout module.
- MainFrm.h: this is the main form class object header file.
- MainFrm.cpp: this is the main form class object.
               All sample codes go in here.
- MainFrm.ddp: this is the diagram portfolio file.
- ISOAPServer.h: this is the WSDL import header file
                 (see details in this file how to import WSDL file).
- ISOAPServer.cpp: this is the WSDL import file
                   (more details in this file).
- RedcoalSOAPService.h: this is the header file containing
                        SOAP server return codes
                        and message types definitions.

************************************************************************

2. How to build the sample project.

To build the project, follow the steps:

1) Open the Borland C++ Builder 6.0 project file "SoapClient.bpr"
   in Borland C++ Builder 6.0 integrated development environment.
   All settings are included in the project file.
2) Choose from menu "Project -> Build SOAPClient".
   The project should compile and the final executable file
   "SOAPClient.exe" built.

The sample codes for the various functions can be viewed
by double-clicking the corresponding buttons.

************************************************************************

3. How to run the sample program.

Before invoking any function in the sample program,
the serial number and the SMS key must be present.


3.1 How to send text SMS

To send text SMS, click the "Text SMS" tab in the middle of the form.
The fields "Reply Email", "Recipients" must also be populated.
In the "Text SMS" tab, the "Originator" must be given if
one-way SMS or flash SMS is chosen. The message body must be given.
By clicking the button "Send", a request will be sent to the server,
sending the corresponding text SMS.

To use the method "SendSMS2", check the checkbox "Use SendSMS2",
The text box labeled "Scheduled (UTC)" will be enabled to allow
input of scheduled time of delivery in UTC.
Leave this field blank if the message is to be sent immediately.
See the MIDA 7.0 document "MIDA70.pdf" for details of "SendSMS2".


3.2 How to send binary SMS

To send binary SMS, click the "Binary SMS" tab.
The fields "Reply Email", "Recipients" must also be populated.
The binary file path must be entered in the "file path" box.
Alternatively, click the "Browse..." button to search for the
binary file and its path will be entered into the box automatically.
Choose the appropriate binary SMS type. For operator logo,
the MCC and MNC must also be given. For picture message,
an optional text part can also be entered in the box provided.
By clicking the button "Send", a request will be sent to the server,
sending the corresponding binary SMS.

To use the method "SendSMS2", check the checkbox "Use SendSMS2",
The text box labeled "Scheduled (UTC)" will be enabled to allow
input of scheduled time of delivery in UTC.
Leave this field blank if the message is to be sent immediately.
See the MIDA 7.0 document "MIDA70.pdf" for details of "SendSMS2".


3.3 How to send MMS

To send MMS, click the "MMS" tab.
There are basically 3 steps in sending MMS:

1) Click the "Create MMS" button and if it succeeds, will return
   an automatically generated unique transaction ID for subsequent
   processing. Alternatively, provide your own unique transaction
   ID, which can be any alphanumeric symbols, in the box provided
   before clicking the "Create MMS" button. When the function
   returns OK, your supplied transaction ID can be used for
   subsequent processing.

2) After a transaction ID has been created for the MMS, the actual
   content can be added. A MMS is just a multipart message, each part
   can contain a different content type. Click the radio button
 of
   the appropriate type. For pictures and musics, the binary file
   must be entered in the "file path" box. Alternatively, click the
   "Browse..." button to search for the binary file and its path
   will be entered into the box automatically. For plain text,
   enter the text in the box provided. Then by clicking the button
   "Add Content", the requested content will be sent to the server
   to be included in this particular MMS.

3) The various contents added are still separated on the server.
   When all contents have been added, they can be sent as a whole
   MMS to the recipients. The fields "Reply Email", "Recipients"
   must also be populated. The field "Subject" can optionally be
   given to describe the MMS. By clicking the button "Send", the
   various contents added will be assembled together into the MMS
   stored on the MMS server. A MMS notification will be sent to the
   recipients whereby the MMS will be retrieved from the MMS server.


3.4 How to send WAP service indication

To send WAP service indication (SI), click the "WAP SI" tab.
The fields "Reply Email", "Recipients" must also be populated.
The WAP SI is like a bookmark to which the receiver can browse.
Hence the URL must be provided. Optionally, the content can be
given in the box provided to further describe the URL.
By clicking the button "Send", a request will be sent to the server,
sending the corresponding WAP service indication.


3.5 How to receive SMS reply

If you have an incoming SMS or have previously sent a 2-way message
and a reply comes back, the incoming message is stored on the server.
To retrieve any incoming message waiting on the server, click the
"Reply SMS" tab. The field "Reply Email" must be given as this
distinguishes your incoming messages from others. By clicking the
button "Get Next", a request will be sent to the server, retrieving
any incoming messages and return them back one by one. The sender,
timestamp and message content will be displayed in their corresponding
boxes. The "Msg Left" provides an indication of how many more
incoming messages are waiting on the server after the current one.
Once an incoming message is retrieved by this function, further
call will not retrieve this message again. Note however that reply
messages will also be sent to your reply email address.


3.6 How to check message status

Everytime a send message request is sent successfully, the function
will return a message ID for this message in the "Message ID" box.
Further status of the message can be queried by clicking the button
"Check" at the bottom, which sends the query to the server, which
will return the status for the message in the "Message Status" box.
Subsequent message sent will have its ID replacing the old one
in the "Message ID" box. Note that both the "Message ID" and
"Message Status" boxes are read-only because they should not be altered.


************************************************************************
